<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html 
     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   <html xmlns="http://www.w3.org/1999/xhtml">
<head>
  <title></title>
  <link rel="stylesheet" href="media/stylesheet.css" />
<!-- template designed by Julien Damon based on PHPEdit's generated templates, and tweaked by Greg Beaver -->
<body bgcolor="#ffffff" ><a name="top"></a>
<h2>Element Index, Package  ESAPI_Filters</h2>
<strong>Indexes by package:</strong><br>
<ul>
<li><a href="elementindex_ESAPI.html">ESAPI</a></li>
<li><a href="elementindex_ESAPI_Codecs.html">ESAPI_Codecs</a></li>
<li><a href="elementindex_ESAPI_Reference_Validation.html">ESAPI_Reference_Validation</a></li>
<li><a href="elementindex_ESAPI_Errors.html">ESAPI_Errors</a></li>
<li><a href="elementindex_ESAPI_Reference.html">ESAPI_Reference</a></li>
</ul>
<a href="elementindex.html"><strong>Index of all elements</strong></a>
<br />
	<a href="elementindex_ESAPI_Filters.html#c">c</a>
	<a href="elementindex_ESAPI_Filters.html#g">g</a>
	<a href="elementindex_ESAPI_Filters.html#o">o</a>
	<a href="elementindex_ESAPI_Filters.html#p">p</a>
	<a href="elementindex_ESAPI_Filters.html#s">s</a>
	<a href="elementindex_ESAPI_Filters.html#_">_</a>

<br /><br />
<table border="0" width="100%">
<thead>
  <tr>
    <td><strong>_</strong></td>
    <td align='right'><a name="_">&nbsp; </a>
                      <a href="#top">top</a><br /></td>
  </tr>
</thead>
<tbody>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>__construct</strong></td>
    <td width="100%" align="left" valign="top">in file SafeRequest.php, method <a href="ESAPI_Filters/SafeRequest.html#method__construct">SafeRequest::__construct()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;SafeRequest can be forced to use the supplied cookies, headers and server  globals by passing an array containing the following keys: 'cookies',  'headers', 'env'.  The values for each of the keys should be an associative  array e.g. 'headers' =&gt; array('REQUEST_METHOD' =&gt; 'GET').</td>
  </tr>
  </tbody>
<thead>
  <tr>
    <td><strong>c</strong></td>
    <td align='right'><a name="c">&nbsp; </a>
                      <a href="#top">top</a><br /></td>
  </tr>
</thead>
<tbody>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>CHARS_ALPHA</strong></td>
    <td width="100%" align="left" valign="top">in file SafeRequest.php, class constant <a href="ESAPI_Filters/SafeRequest.html#constCHARS_ALPHA">SafeRequest::CHARS_ALPHA</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>CHARS_FILESYSTEM_PATH</strong></td>
    <td width="100%" align="left" valign="top">in file SafeRequest.php, class constant <a href="ESAPI_Filters/SafeRequest.html#constCHARS_FILESYSTEM_PATH">SafeRequest::CHARS_FILESYSTEM_PATH</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>CHARS_HTTP_COOKIE_NAME</strong></td>
    <td width="100%" align="left" valign="top">in file SafeRequest.php, class constant <a href="ESAPI_Filters/SafeRequest.html#constCHARS_HTTP_COOKIE_NAME">SafeRequest::CHARS_HTTP_COOKIE_NAME</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>CHARS_HTTP_COOKIE_VALUE</strong></td>
    <td width="100%" align="left" valign="top">in file SafeRequest.php, class constant <a href="ESAPI_Filters/SafeRequest.html#constCHARS_HTTP_COOKIE_VALUE">SafeRequest::CHARS_HTTP_COOKIE_VALUE</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>CHARS_HTTP_HEADER_NAME</strong></td>
    <td width="100%" align="left" valign="top">in file SafeRequest.php, class constant <a href="ESAPI_Filters/SafeRequest.html#constCHARS_HTTP_HEADER_NAME">SafeRequest::CHARS_HTTP_HEADER_NAME</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>CHARS_HTTP_HEADER_VALUE</strong></td>
    <td width="100%" align="left" valign="top">in file SafeRequest.php, class constant <a href="ESAPI_Filters/SafeRequest.html#constCHARS_HTTP_HEADER_VALUE">SafeRequest::CHARS_HTTP_HEADER_VALUE</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>CHARS_HTTP_HOSTNAME</strong></td>
    <td width="100%" align="left" valign="top">in file SafeRequest.php, class constant <a href="ESAPI_Filters/SafeRequest.html#constCHARS_HTTP_HOSTNAME">SafeRequest::CHARS_HTTP_HOSTNAME</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>CHARS_HTTP_QUERY_STRING</strong></td>
    <td width="100%" align="left" valign="top">in file SafeRequest.php, class constant <a href="ESAPI_Filters/SafeRequest.html#constCHARS_HTTP_QUERY_STRING">SafeRequest::CHARS_HTTP_QUERY_STRING</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>CHARS_HTTP_REMOTE_USER</strong></td>
    <td width="100%" align="left" valign="top">in file SafeRequest.php, class constant <a href="ESAPI_Filters/SafeRequest.html#constCHARS_HTTP_REMOTE_USER">SafeRequest::CHARS_HTTP_REMOTE_USER</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>CHARS_HTTP_REQUEST_URI</strong></td>
    <td width="100%" align="left" valign="top">in file SafeRequest.php, class constant <a href="ESAPI_Filters/SafeRequest.html#constCHARS_HTTP_REQUEST_URI">SafeRequest::CHARS_HTTP_REQUEST_URI</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>CHARS_NUMERIC</strong></td>
    <td width="100%" align="left" valign="top">in file SafeRequest.php, class constant <a href="ESAPI_Filters/SafeRequest.html#constCHARS_NUMERIC">SafeRequest::CHARS_NUMERIC</a></td>
  </tr>
  </tbody>
<thead>
  <tr>
    <td><strong>g</strong></td>
    <td align='right'><a name="g">&nbsp; </a>
                      <a href="#top">top</a><br /></td>
  </tr>
</thead>
<tbody>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>getAuthType</strong></td>
    <td width="100%" align="left" valign="top">in file SafeRequest.php, method <a href="ESAPI_Filters/SafeRequest.html#methodgetAuthType">SafeRequest::getAuthType()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns the value of $_SERVER['AUTH_TYPE'] if it is present or an  empty string if it is not.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>getContentLength</strong></td>
    <td width="100%" align="left" valign="top">in file SafeRequest.php, method <a href="ESAPI_Filters/SafeRequest.html#methodgetContentLength">SafeRequest::getContentLength()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns the value of $_SERVER['CONTENT_LENGTH'] if it is present or zero  otherwise.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>getContentType</strong></td>
    <td width="100%" align="left" valign="top">in file SafeRequest.php, method <a href="ESAPI_Filters/SafeRequest.html#methodgetContentType">SafeRequest::getContentType()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns the value of $_SERVER['CONTENT_TYPE'] if it is present or an  empty string if it is not.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>getCookie</strong></td>
    <td width="100%" align="left" valign="top">in file SafeRequest.php, method <a href="ESAPI_Filters/SafeRequest.html#methodgetCookie">SafeRequest::getCookie()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Retreives a named http cookie value.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>getCookies</strong></td>
    <td width="100%" align="left" valign="top">in file SafeRequest.php, method <a href="ESAPI_Filters/SafeRequest.html#methodgetCookies">SafeRequest::getCookies()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns an associative array of HTTP Cookies.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>getHeader</strong></td>
    <td width="100%" align="left" valign="top">in file SafeRequest.php, method <a href="ESAPI_Filters/SafeRequest.html#methodgetHeader">SafeRequest::getHeader()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Retreives a named HTTP header value.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>getHeaders</strong></td>
    <td width="100%" align="left" valign="top">in file SafeRequest.php, method <a href="ESAPI_Filters/SafeRequest.html#methodgetHeaders">SafeRequest::getHeaders()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns an associative array of valid, canonical HTTP Headers.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>getMethod</strong></td>
    <td width="100%" align="left" valign="top">in file SafeRequest.php, method <a href="ESAPI_Filters/SafeRequest.html#methodgetMethod">SafeRequest::getMethod()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns the value of $_SERVER['REQUEST_METHOD'] if it is present or an  empty string if it is not.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>getParameter</strong></td>
    <td width="100%" align="left" valign="top">in file SafeRequest.php, method <a href="ESAPI_Filters/SafeRequest.html#methodgetParameter">SafeRequest::getParameter()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns the value of a request parameter as a String, or null if the  parameter does not exist. Request parameters are contained in the query  string or posted form data and are retreived from the $_GET and $_POST PHP  globals {@see getParameterMap}.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>getParameterMap</strong></td>
    <td width="100%" align="left" valign="top">in file SafeRequest.php, method <a href="ESAPI_Filters/SafeRequest.html#methodgetParameterMap">SafeRequest::getParameterMap()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns an associative array of the parameters of this request. Request  parameters are contained in the query string or posted form data and are  retreived from the $_GET and $_POST PHP globals.  The keys of the array are  canonicalized strings and the values are arrays of canonicalized strings.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>getParameterNames</strong></td>
    <td width="100%" align="left" valign="top">in file SafeRequest.php, method <a href="ESAPI_Filters/SafeRequest.html#methodgetParameterNames">SafeRequest::getParameterNames()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns an array containing the names of all parameters for this request.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>getParameterValues</strong></td>
    <td width="100%" align="left" valign="top">in file SafeRequest.php, method <a href="ESAPI_Filters/SafeRequest.html#methodgetParameterValues">SafeRequest::getParameterValues()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Retrieves all values for the supplied parameter of this request as an array.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>getPathInfo</strong></td>
    <td width="100%" align="left" valign="top">in file SafeRequest.php, method <a href="ESAPI_Filters/SafeRequest.html#methodgetPathInfo">SafeRequest::getPathInfo()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns the value of $_SERVER['PATH_INFO'] if it is present or an  empty string if it is not.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>getPathTranslated</strong></td>
    <td width="100%" align="left" valign="top">in file SafeRequest.php, method <a href="ESAPI_Filters/SafeRequest.html#methodgetPathTranslated">SafeRequest::getPathTranslated()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns the value of $_SERVER['PATH_TRANSLATED'] if it is present or an  empty string if it is not.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>getQueryString</strong></td>
    <td width="100%" align="left" valign="top">in file SafeRequest.php, method <a href="ESAPI_Filters/SafeRequest.html#methodgetQueryString">SafeRequest::getQueryString()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns the value of $_SERVER['QUERY_STRING'] if it is present or an  empty string if it is not.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>getRemoteAddr</strong></td>
    <td width="100%" align="left" valign="top">in file SafeRequest.php, method <a href="ESAPI_Filters/SafeRequest.html#methodgetRemoteAddr">SafeRequest::getRemoteAddr()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns the value of $_SERVER['REMOTE_ADDR'] if it is present or an  empty string if it is not.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>getRemoteHost</strong></td>
    <td width="100%" align="left" valign="top">in file SafeRequest.php, method <a href="ESAPI_Filters/SafeRequest.html#methodgetRemoteHost">SafeRequest::getRemoteHost()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns the value of $_SERVER['REMOTE_HOST'] if it is present or an  empty string if it is not.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>getRemoteUser</strong></td>
    <td width="100%" align="left" valign="top">in file SafeRequest.php, method <a href="ESAPI_Filters/SafeRequest.html#methodgetRemoteUser">SafeRequest::getRemoteUser()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns the value of $_SERVER['REMOTE_USER'] if it is present or an  empty string if it is not.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>getRequestURI</strong></td>
    <td width="100%" align="left" valign="top">in file SafeRequest.php, method <a href="ESAPI_Filters/SafeRequest.html#methodgetRequestURI">SafeRequest::getRequestURI()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns the URI from the HTTP Request line exlcuding any path info and the  query string.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>getServerGlobal</strong></td>
    <td width="100%" align="left" valign="top">in file SafeRequest.php, method <a href="ESAPI_Filters/SafeRequest.html#methodgetServerGlobal">SafeRequest::getServerGlobal()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns the value of the PHP Server Global with the supplied name. If the  variable does not exist then null is returned.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>getServerName</strong></td>
    <td width="100%" align="left" valign="top">in file SafeRequest.php, method <a href="ESAPI_Filters/SafeRequest.html#methodgetServerName">SafeRequest::getServerName()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns the value of $_SERVER['SERVER_NAME'] if it is present or an  empty string if it is not.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>getServerPort</strong></td>
    <td width="100%" align="left" valign="top">in file SafeRequest.php, method <a href="ESAPI_Filters/SafeRequest.html#methodgetServerPort">SafeRequest::getServerPort()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns the value of $_SERVER['SERVER_PORT'] if it is present or zero if it  is not.</td>
  </tr>
  </tbody>
<thead>
  <tr>
    <td><strong>o</strong></td>
    <td align='right'><a name="o">&nbsp; </a>
                      <a href="#top">top</a><br /></td>
  </tr>
</thead>
<tbody>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>ORD_TAB</strong></td>
    <td width="100%" align="left" valign="top">in file SafeRequest.php, class constant <a href="ESAPI_Filters/SafeRequest.html#constORD_TAB">SafeRequest::ORD_TAB</a></td>
  </tr>
  </tbody>
<thead>
  <tr>
    <td><strong>p</strong></td>
    <td align='right'><a name="p">&nbsp; </a>
                      <a href="#top">top</a><br /></td>
  </tr>
</thead>
<tbody>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>PATTERN_HOST_NAME</strong></td>
    <td width="100%" align="left" valign="top">in file SafeRequest.php, class constant <a href="ESAPI_Filters/SafeRequest.html#constPATTERN_HOST_NAME">SafeRequest::PATTERN_HOST_NAME</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>PATTERN_IPV4_ADDRESS</strong></td>
    <td width="100%" align="left" valign="top">in file SafeRequest.php, class constant <a href="ESAPI_Filters/SafeRequest.html#constPATTERN_IPV4_ADDRESS">SafeRequest::PATTERN_IPV4_ADDRESS</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>PATTERN_REQUEST_AUTHTYPE</strong></td>
    <td width="100%" align="left" valign="top">in file SafeRequest.php, class constant <a href="ESAPI_Filters/SafeRequest.html#constPATTERN_REQUEST_AUTHTYPE">SafeRequest::PATTERN_REQUEST_AUTHTYPE</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>PATTERN_REQUEST_METHOD</strong></td>
    <td width="100%" align="left" valign="top">in file SafeRequest.php, class constant <a href="ESAPI_Filters/SafeRequest.html#constPATTERN_REQUEST_METHOD">SafeRequest::PATTERN_REQUEST_METHOD</a></td>
  </tr>
  </tbody>
<thead>
  <tr>
    <td><strong>s</strong></td>
    <td align='right'><a name="s">&nbsp; </a>
                      <a href="#top">top</a><br /></td>
  </tr>
</thead>
<tbody>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>SafeRequest.php</strong></td>
    <td width="100%" align="left" valign="top">procedural page <a href="ESAPI_Filters/_filters---SafeRequest.php.html">SafeRequest.php</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>SafeRequest</strong></td>
    <td width="100%" align="left" valign="top">in file SafeRequest.php, class <a href="ESAPI_Filters/SafeRequest.html">SafeRequest</a><br>&nbsp;&nbsp;&nbsp;&nbsp;This request wrapper simply provides convenient and safe methods for the  retreival of HTTP request parameters, headers and PHP server globals defined in  the CGI 1.1 Specification.  The methods perform canonicalization and validation  of the requested values or return safe defaults such as empty strings.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>setEncoder</strong></td>
    <td width="100%" align="left" valign="top">in file SafeRequest.php, method <a href="ESAPI_Filters/SafeRequest.html#methodsetEncoder">SafeRequest::setEncoder()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Sets the encoder instance to be used for encoding/decoding, canonicalization  and validation.</td>
  </tr>
  </tbody>
</table></body>
</html>